Skip to content

docs(tool-executions): follow the Logging Policy rename, and fix the API credential - #1157

Merged
josebarrueta merged 1 commit into
add-doc-screenshotsfrom
plt-3107-logging-policy-rename
Aug 28, 2026
Merged

docs(tool-executions): follow the Logging Policy rename, and fix the API credential#1157
josebarrueta merged 1 commit into
add-doc-screenshotsfrom
plt-3107-logging-policy-rename

Conversation

@josebarrueta

@josebarrueta josebarrueta commented Aug 28, 2026

Copy link
Copy Markdown
Contributor

Follows ArcadeAI/monorepo#3670, which renamed the dashboard page from Execution Logging to Logging Policy.

Targets add-doc-screenshots because that is where the page lives — #1141 merged there and the branch has not reached main yet.

Three changes

The rename. "Open your organization in the dashboard and select Execution Logging" named neither the current label nor the path. Now Organization → Logging Policy.

The endpoint URL, which was wrong from the start. logging-config is a Coordinator route. Every other Coordinator orgs/ call on this site is cloud.arcade.dev/api/v1/; only this page said api.arcade.dev/v1/. Against a live stack, /v1/orgs/... returns 404 and /api/v1/orgs/... resolves.

A note on the credential. A project API key is refused here with 401 Invalid credentials: missing account ID — the route resolves an account, because the policy belongs to the organization rather than a project. The variable stays $ARCADE_API_KEY, matching the audit log page, which documents the same org-scoped shape as "User (API key/JWT)"; the added sentence just says a project key will not do.

Verified against a live stack

Signed in as an org admin, walked the page, then exercised every factual claim through the API:

Claim Result
Recording enabled by default logging_data_retention = ALLOWED
Window starts at 7 days default_log_retention_days = 7
Maximum is 90, reported as max_log_retention_days 90
Zero refused, not "keep nothing" 422
Over maximum refused, not clamped 91422
1 and 90 accepted 200
An omitted field is left alone window survived a recording-only write
Project API key 401

Sidebar, breadcrumb and page heading all read Logging Policy for an org admin.

Two caveats

Generate LLMs.txt fails on this PR, and on every PR. It dies at checkout — could not read Username for 'https://github.com' — because secrets.DOCS_PUBLISHABLE_GH_TOKEN resolves empty. Every run since 2026-08-26 18:43 has failed across three authors' branches. Unrelated to this change, but someone with repo admin should reissue that token.

pnpm build fails on this branch with Module not found: '@arcadeai/ui-kit/utils/attribution' in proxy.ts. Pre-existing — it fails identically with this change stashed — so the MDX here is not build-validated.

Note on the second commit

8e7c9a33 introduced $ARCADE_ACCOUNT_TOKEN, a variable that does not exist. 7fba7342 reverts it and fixes the URL. Reviewing the head commit is enough; the intermediate state is wrong.

…that works

The dashboard page is called Logging Policy now, and it sits under
Organization, so "open your organization and select Execution Logging" names
neither the label nor the path a reader would follow.

The curl was worse than stale. It sent `$ARCADE_API_KEY`, which every other
sample on the site means as a project key, and this endpoint refuses one:
`401 Invalid credentials: missing account ID`. The policy is org-scoped and the
route resolves an account, so a project key cannot carry the caller. Verified
against a live stack — the same request with an account token returns 200.

Everything else on the page was checked against that stack and holds: recording
starts ALLOWED, the window starts at 7 with a maximum of 90 reported as
`max_log_retention_days`, 0 and 91 are both refused with 422 rather than
clamped, and sending one field leaves the other alone.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@vercel

vercel Bot commented Aug 28, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview Aug 28, 2026 5:50pm

Request Review

@josebarrueta
josebarrueta merged commit 553bdb9 into add-doc-screenshots Aug 28, 2026
7 of 8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant